/**
 * Copyright 2008 Adam Ruggles.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kiff.util.model;

/**
 * Token interface.
 * @author Adam
 * @version $Id$
 * 
 * Created on Dec 4, 2008 at 8:17:28 PM 
 */
public interface Token {
	/**
	 * Returns action.
	 * @return the action.
	 */
	int getAction();

	/**
	 * Returns the state that was saved with the token.
	 * @return The state.
	 */
	int getState();

	/**
	 * Returns the text for the token.
	 * @return The text.
	 */
	String getText();

	/**
	 * Sets action.
	 * @param action the action to set.
	 */
	void setAction(int action);

	/**
	 * Sets the state to save with the token.
	 * @param state The state to set.
	 */
	void setState(int state);

	/**
	 * Sets the text of the token.
	 * @param text The text of the token.
	 */
	void setText(String text);
}
